Skip to content


ai  101  pytorch  classification  nvidia  cuda  install  tensorrt  yolo  ardupilot  None  ros2  dds  micro ros  xrce  sitl  plugin  SITL  debug  rangefinder  pymavlink  mavros  gazebo  distance sensor  system_time  timesync  cmake  gtest  ctest  cpp  c++  format  fmt  multithreading  spdlog  camera  coordinate system  orb  matching  opencv  build  transformation  computer vision  homography  optical flow  of  trackers  cv  cyclonedds  eprosima  fastdds  simulation  config  ignition  bridge  sdf  tips  ign-transport  sensors  lidar  aptly  apt  encryption  pgp  docker  git  bundle  github  hooks  pre-commit  lxd  container  lxc  x11  profile  vscode  marpit  presentation  marp  markdown  mermaid  video  ffmpeg  gstreamer  cheat-sheet  sdp  v4l2loopback  gi  snippets  cheat Sheet  python  asyncio  future  click  cli  numpy  project  template  black  isort  docs  project document  docstrings  flake8  linter  git-hook  mypy  unittest  pytest  pylint  mock  iterator  generator  logging  tuple  namedtuple  typing  annotation  pyzmq  zmq  msgpack  action  namespace  remap  control2  ros2_control  gdb  qos  tag  plugins  msg  node  zero-copy  shm  tutorial  algorithm  calibration  diff  pid  dev  colcon  colcon_cd  rpi  arm  qemu  settings  behavior  plot  visualization  debugging  diagnostic  diagnostics  tutorials  gst  math  apm  rat_runtime_monitor  web  rosbridge  vue  binding  discovery  gazebo-classic  launch  spawn  cook  gps  imu  ray  gazebo_ros_ray_sensor  ultrsonic  range  ultrasonic  gazebo classic  wrench  effort  odom  ign  gz  xacro  ros_ign  diff_drive  odometry  joint_state  argument  OpaqueFunction  DeclareLaunchArgument  LaunchConfiguration  tmux  nav  slam  test  rclpy  executor  MultiThreadedExecutor  SingleThreadedExecutor  param  dynamic-reconfigure  service  client  setup.py  package.xml  parameter  parameters  custom  msgs  executers  pub  sub  rqt  rviz  rviz2  pose  marker  tf2  deb  package  setup  local_setup  rosdep  package manager  project settings  vcstool  cross-compiler  nano  texture  tmuxp  rootfs  embedded  zah  linux  rm  ubuntu  ip  ss  network  netstat  snap  deploy  ssh  systemd  mkdocs  extensions  socat  networking  serial  udp  tc  mtu  select  px4  robotics  kalman_filter  kalman  filter  control  todo  vscode-ext  json  yaml  schema  yocto  poky  world  gazebo_ros2_control  position_controller  effort_controller  velocity_controller  urdf  gazebo_ros_force  gazebo_ros_joint_state_publisher  robot_state_publisher  joint_state_publisher  projects  vrx  buoyancy 

Click#

Click is a Python package for creating beautiful command line interfaces in a composable way with as little code as necessary. It’s the “Command Line Interface Creation Kit”. click web site

install#

pip install click

Demo#

A function becomes a Click command line tool by decorating it through click.command()

import click

@click.command()
def hello():
    print("hello")

if __name__ == "__main__":
    hello()

usage

python hello_click.py --help
Usage: hello_click.py [OPTIONS]

Options:
  --help  Show this message and exit.


Add option#

Option has a lot of options … Options

import click

@click.command()
@click.option("--count", default=1, help="No. of hello's")
def hello(count=0):
    for _ in range(count):
        print("hello")

if __name__ == "__main__":
    hello()

Function default value

Add default value in function just for lint , to disabled errors click option decorate is charge for default add pass the argument from command line

usage

python 
hello_click.py --help
Usage: hello_click.py [OPTIONS]

Options:
  --count INTEGER  No. of hello's
  --help           Show this message and exit.

python hello_click.py --count=3

Add arguments#

Arguments work similarly to options but are positional, they has less features and click will not create document for them more

import click

@click.command()
@click.option("--count", default=1, help="No. of hello's")
@click.argument("name")
def hello(name="", count=0):
    for _ in range(count):
        print(name)

if __name__ == "__main__":
    hello()

usage

python hello_click.py --help   
Usage: hello_click.py [OPTIONS] NAME

Options:
  --count INTEGER  No. of hello's
  --help           Show this message and exit.


Group commands#

Commands and Groups

import click

@click.group()
def cli():
    pass

@cli.command(help="create dummy")
def create():
    print("create")

@cli.command(help="remove dummy")
def remove():
    print("remove")


if __name__ == "__main__":
    cli()

Assing command to group

Replace click decorate with group function name for example cli

usage

python hello_click.py --help
Usage: hello_click.py [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  create  create dummy
  remove  remove dummy